Add the Uri\Rfc3986\Uri class to ext/uri without wither support #18836

kocsismate · 2025-06-11T17:57:49Z

There are a few WIP parts but the PR can already be reviewed.

Relates to #14461 and https://wiki.php.net/rfc/url_parsing_api

ext/uri/php_uriparser.c

ext/uri/uriparser/include/uriparser/Uri.h

nielsdos

Cursory glance, I see there's some todos wrt memory management as well so maybe I'll wait a bit on that

Zend/zend_string.h

ext/uri/php_uri.c

ext/uri/php_uriparser.c

TimWolla

Some first remarks from just looking at the diff on GitHub.

ext/uri/php_uriparser.c

TimWolla · 2025-06-11T18:16:46Z

ext/uri/php_uriparser.c

+	UriUriA *uri, zend_string *uri_str,
+	UriUriA *normalized_uri, zend_string *normalized_uri_str
+) {
+	uriparser_uris_t *uriparser_uris = emalloc(sizeof(uriparser_uris_t));


Suggested change

uriparser_uris_t *uriparser_uris = emalloc(sizeof(uriparser_uris_t));

uriparser_uris_t *uriparser_uris = emalloc(sizeof(*uriparser_uris));

Prevents the two types from going out of sync (same elsewhere).

ext/uri/php_uriparser.c

TimWolla · 2025-06-12T07:19:33Z

ext/uri/php_uriparser.c

Something I'm only noticing now: I think this should rather be called ext/uri/parser_rfc3986.c and php_lexbor.c would be ext/uri/parser_whatwg.c. The php_uriparser.c name is confusing to me, because uriparser is an extremely generic term.

To give another comparison with ext/random, since it is architecturally similar: Each engine has its own engine_enginename.c file, e.g. engine_xoshiro256starstar.c.

TimWolla · 2025-06-12T07:22:45Z

ext/uri/php_uriparser.c

+	efree(uriparser_uris);
+}
+
+const uri_handler_t uriparser_uri_handler = {


And similarly the public symbols in the file should also be prefixed with php_uri_. Just uriparser_ can conflict with the uriparser library itself.

Here I would suggest php_uri_rfc3986_handler.

But I'm also happy to leave this to a follow-up to not introduce too much churn.

Yes, this and the file renaming is something that I'm happy to do after most parts are merged.

ext/uri/php_uriparser.h

ext/uri/php_uri.c

ext/uri/php_uriparser.c

TimWolla · 2025-06-12T07:45:36Z

ext/uri/php_uriparser.h

+typedef struct uriparser_uris_t {
+	UriUriA *uri;
+	zend_string *uri_str;
+	UriUriA *normalized_uri;
+	zend_string *normalized_uri_str;
+} uriparser_uris_t;


Suggested change

typedef struct uriparser_uris_t {

UriUriA *uri;

zend_string *uri_str;

UriUriA *normalized_uri;

zend_string *normalized_uri_str;

} uriparser_uris_t;

typedef struct uriparser_uris_t {

UriUriA uri;

zend_string *uri_str;

UriUriA normalized_uri;

zend_string *normalized_uri_str;

} uriparser_uris_t;

From what I see, the uriparser library does not allocate UriUriA structs itself, but requires you to pass in an OUT-pointer. Thus we can just stack-allocate it / embed it into another struct.

The uri field is a good candidate indeed, but the normalized_uri field is initialized on demand (by uriparser_read_uri). So we would have to track its initialization status by a separate bool field because UriUriA doesn't provide any indication. Is it still desirable to allocate on stack even if it causes some maintainability degradation?

Is it still desirable to allocate on stack even if it causes some maintainability degradation?

I feel that a separate bool would also be simpler on the maintenance, since you would have less allocs / frees to deal with, but use whatever “feels comfortable”.

TimWolla · 2025-06-12T07:49:11Z

ext/uri/php_uriparser.c

+	UriUriA *uriparser_uri = emalloc(sizeof(UriUriA));
+
+	/* uriparser keeps the originally passed in string, while lexbor may allocate a new one. */
+	zend_string *original_uri_str = zend_string_init(ZSTR_VAL(uri_str), ZSTR_LEN(uri_str), false);
+	if (ZSTR_LEN(original_uri_str) == 0 ||
+		uriParseSingleUriExA(uriparser_uri, ZSTR_VAL(original_uri_str), ZSTR_VAL(original_uri_str) + ZSTR_LEN(original_uri_str), NULL) != URI_SUCCESS
+	) {
+		efree(uriparser_uri);
+		zend_string_release_ex(original_uri_str, false);
+		if (!silent) {
+			throw_invalid_uri_exception();
+		}
+
+		return NULL;
+	}
+
+	if (uriparser_base_urls == NULL) {
+		return uriparser_create_uris(uriparser_uri, original_uri_str, NULL, NULL);
+	}
+
+	UriUriA *uriparser_base_url = uriparser_copy_uri(uriparser_base_urls->uri);
+
+	UriUriA *absolute_uri = emalloc(sizeof(UriUriA));
+
+	if (uriAddBaseUriExA(absolute_uri, uriparser_uri, uriparser_base_url, URI_RESOLVE_STRICTLY) != URI_SUCCESS) {
+		zend_string_release_ex(original_uri_str, false);
+		uriFreeUriMembersA(uriparser_uri);
+		efree(uriparser_uri);
+		uriFreeUriMembersA(uriparser_base_url);
+		efree(uriparser_base_url);
+		efree(absolute_uri);
+
+		if (!silent) {
+			throw_invalid_uri_exception();
+		}
+
+		return NULL;
+	}
+
+	/* TODO fix freeing: if the following code runs, then we'll have use-after-free-s because uriparser doesn't
+	   copy the input. If we don't run the following code, then we'll have memory leaks...
+	uriFreeUriMembersA(uriparser_base_url);
+	efree(uriparser_base_url);
+	uriFreeUriMembersA(uriparser_uri);
+	efree(uriparser_uri);
+	 */
+
+	return uriparser_create_uris(absolute_uri, original_uri_str, NULL, NULL);


Rough untested suggestion. Basically: Keep the UriUriA object stack-allocated for as long as possible.

Suggested change

UriUriA *uriparser_uri = emalloc(sizeof(UriUriA));

/* uriparser keeps the originally passed in string, while lexbor may allocate a new one. */

zend_string *original_uri_str = zend_string_init(ZSTR_VAL(uri_str), ZSTR_LEN(uri_str), false);

if (ZSTR_LEN(original_uri_str) == 0 ||

uriParseSingleUriExA(uriparser_uri, ZSTR_VAL(original_uri_str), ZSTR_VAL(original_uri_str) + ZSTR_LEN(original_uri_str), NULL) != URI_SUCCESS

) {

efree(uriparser_uri);

zend_string_release_ex(original_uri_str, false);

if (!silent) {

throw_invalid_uri_exception();

}

return NULL;

}

if (uriparser_base_urls == NULL) {

return uriparser_create_uris(uriparser_uri, original_uri_str, NULL, NULL);

}

UriUriA *uriparser_base_url = uriparser_copy_uri(uriparser_base_urls->uri);

UriUriA *absolute_uri = emalloc(sizeof(UriUriA));

if (uriAddBaseUriExA(absolute_uri, uriparser_uri, uriparser_base_url, URI_RESOLVE_STRICTLY) != URI_SUCCESS) {

zend_string_release_ex(original_uri_str, false);

uriFreeUriMembersA(uriparser_uri);

efree(uriparser_uri);

uriFreeUriMembersA(uriparser_base_url);

efree(uriparser_base_url);

efree(absolute_uri);

if (!silent) {

throw_invalid_uri_exception();

}

return NULL;

}

/* TODO fix freeing: if the following code runs, then we'll have use-after-free-s because uriparser doesn't

copy the input. If we don't run the following code, then we'll have memory leaks...

uriFreeUriMembersA(uriparser_base_url);

efree(uriparser_base_url);

uriFreeUriMembersA(uriparser_uri);

efree(uriparser_uri);

*/

return uriparser_create_uris(absolute_uri, original_uri_str, NULL, NULL);

UriUriA uriparser_uri;

/* uriparser keeps the originally passed in string, while lexbor may allocate a new one. */

zend_string *original_uri_str = zend_string_init(ZSTR_VAL(uri_str), ZSTR_LEN(uri_str), false);

if (ZSTR_LEN(original_uri_str) == 0 ||

uriParseSingleUriExA(&uriparser_uri, ZSTR_VAL(original_uri_str), ZSTR_VAL(original_uri_str) + ZSTR_LEN(original_uri_str), NULL) != URI_SUCCESS

) {

zend_string_release_ex(original_uri_str, false);

if (!silent) {

throw_invalid_uri_exception();

}

return NULL;

}

if (uriparser_base_urls == NULL) {

return uriparser_create_uris(&uriparser_uri, original_uri_str, NULL, NULL);

}

UriUriA absolute_uri;

if (uriAddBaseUriExA(&absolute_uri, uriparser_uri, &uriparser_base_urls->uri, URI_RESOLVE_STRICTLY) != URI_SUCCESS) {

zend_string_release_ex(original_uri_str, false);

uriFreeUriMembersA(uriparser_uri);

uriFreeUriMembersA(uriparser_base_url);

if (!silent) {

throw_invalid_uri_exception();

}

return NULL;

}

/* TODO fix freeing: if the following code runs, then we'll have use-after-free-s because uriparser doesn't

copy the input. If we don't run the following code, then we'll have memory leaks...

uriFreeUriMembersA(uriparser_base_url);

efree(uriparser_base_url);

uriFreeUriMembersA(uriparser_uri);

efree(uriparser_uri);

*/

return uriparser_create_uris(&absolute_uri, original_uri_str, NULL, NULL);

I implemented the suggestion of allocating on stack. My feeling is that the end result didn't become any simpler, but I guess there will be some performance benefit (I didn't do any measurements yet). I'm currently re-running the same microbenchmarks on a separate test branch that the original PR had (kocsismate#7).

ext/uri/php_uri.c

ext/uri/php_uriparser.c

kocsismate · 2025-06-15T04:36:13Z

The following patch fixes the leaks / memory management for me:

@TimWolla Thanks for the patch, it's awesome! TBH I didn't even think about using the UriMakeOwnerA() function, because I wanted to avoid its performance penalty. But you are right, this is the right call, it simplifies the code so much. I love it!

TimWolla · 2025-06-15T10:14:46Z

@kocsismate When stack allocating the struct the code should become even simpler (and possibly faster, due to fewer pointer indirection).

ext/uri/php_uriparser.c

Relates to php#14461 and https://wiki.php.net/rfc/url_parsing_api

Co-authored-by: Tim Düsterhus <[email protected]>

kocsismate requested a review from dstogov as a code owner June 11, 2025 17:57

github-actions bot added Category: Build System Category: Engine ABI break Extension: uri labels Jun 11, 2025

kocsismate requested review from TimWolla and nielsdos and removed request for dstogov June 11, 2025 17:58

kocsismate marked this pull request as draft June 11, 2025 17:58

kocsismate force-pushed the ext-url6 branch 2 times, most recently from 43c1d9f to 155e070 Compare June 11, 2025 18:07

kocsismate changed the title ~~Add Uri\Rfc3986\Uri class to ext/uri~~ Add the Uri\Rfc3986\Uri class to ext/uri without wither support Jun 11, 2025

kocsismate commented Jun 11, 2025

View reviewed changes

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

kocsismate commented Jun 11, 2025

View reviewed changes

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

kocsismate commented Jun 11, 2025

View reviewed changes

ext/uri/uriparser/include/uriparser/Uri.h Outdated Show resolved Hide resolved

nielsdos requested changes Jun 11, 2025

View reviewed changes

TimWolla reviewed Jun 11, 2025

View reviewed changes

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

kocsismate mentioned this pull request Jun 11, 2025

[RFC] Add RFC 3986 and WHATWG compliant URL parsing support #14461

Open

TimWolla reviewed Jun 12, 2025

View reviewed changes

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

TimWolla reviewed Jun 12, 2025

View reviewed changes

DanielEScherzer reviewed Jun 12, 2025

View reviewed changes

ext/uri/php_uri.c Outdated Show resolved Hide resolved

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

kocsismate force-pushed the ext-url6 branch from 7438aab to e50f18b Compare June 15, 2025 04:53

kocsismate marked this pull request as ready for review June 16, 2025 07:59

kocsismate force-pushed the ext-url6 branch 2 times, most recently from 0b3cfd8 to 062dc4d Compare June 20, 2025 06:04

TimWolla mentioned this pull request Jun 20, 2025

allow to build with system liburiparser #18886

Open

kocsismate force-pushed the ext-url6 branch from 062dc4d to 055e486 Compare June 20, 2025 20:30

nielsdos requested changes Jun 21, 2025

View reviewed changes

ext/uri/php_uriparser.c Outdated Show resolved Hide resolved

kocsismate and others added 12 commits June 26, 2025 12:05

Add Uri\Rfc3986\Uri class to ext/uri

cc8ae13

Relates to php#14461 and https://wiki.php.net/rfc/url_parsing_api

Review round 1 fixes

dfa41c4

Another batch of fixes

4129b3f

Fix memory management

964d2ef

Co-authored-by: Tim Düsterhus <[email protected]>

Fix Windows build

e8c4a49

Install uriparser header on Windows

3bd9167

Improve and simplify exceptions

9a2e89a

Remove accidentally added extra ;

2ca8252

Try to incorporate uriparser_copy_uri into uriparser

52d424d

Try to fix Windows build again

7fe9270

uriparser improvements

1904e5a

More improvements

6e27188

kocsismate force-pushed the ext-url6 branch from 65f4ebc to 9b63691 Compare June 26, 2025 11:41

Allocate on stack

e0b40a7

kocsismate force-pushed the ext-url6 branch from 9b63691 to e0b40a7 Compare June 26, 2025 12:03

	uriparser_uris_t *uriparser_uris = emalloc(sizeof(uriparser_uris_t));
	uriparser_uris_t uriparser_uris = emalloc(sizeof(uriparser_uris));

Add the Uri\Rfc3986\Uri class to ext/uri without wither support #18836

Are you sure you want to change the base?

Add the Uri\Rfc3986\Uri class to ext/uri without wither support #18836

Uh oh!

Conversation

kocsismate commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nielsdos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TimWolla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

kocsismate commented Jun 15, 2025

Uh oh!

TimWolla commented Jun 15, 2025

Uh oh!

Uh oh!

Uh oh!

kocsismate commented Jun 11, 2025 •

edited

Loading